<?xml version="1.0" ?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title>B&lt;timescanner&gt; - A recursive scanner to produce timeline data extracted from file artifacts</title>
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
<link rev="made" href="mailto:root@localhost" />
</head>

<body style="background-color: white">


<!-- INDEX BEGIN -->
<div name="index">
<p><a name="__index__"></a></p>

<ul>

	<li><a href="#name">NAME</a></li>
	<li><a href="#description">DESCRIPTION</a></li>
	<li><a href="#synopsis">SYNOPSIS</a></li>
	<li><a href="#options">OPTIONS</a></li>
	<li><a href="#author">AUTHOR</a></li>
	<li><a href="#copyright">COPYRIGHT</a></li>
	<li><a href="#see_also">SEE ALSO</a></li>
</ul>

<hr name="index" />
</div>
<!-- INDEX END -->

<p>
</p>
<hr />
<h1><a name="name">NAME</a></h1>
<p><strong>timescanner</strong> - A recursive scanner to produce timeline data extracted from file artifacts</p>
<p>
</p>
<hr />
<h1><a name="description">DESCRIPTION</a></h1>
<p><strong>timscanner</strong> recursively scans through a directory (such as a mounted filesystem) and extracts timestamp data gathered from the files that the tool <em>log2timeline</em> supports.
This tool is written as a separate tool from <strong>log2timeline</strong> but will be integrated in the tool soon.</p>
<p>
</p>
<hr />
<h1><a name="synopsis">SYNOPSIS</a></h1>
<p><strong>timescanner</strong> [OPTIONS] -z TIMEZONE [-f INPUT MODULE] [-o OUTPUT MODULE] [-w BODYFILE] [-v] -d|-dir DIRECTORY</p>
<p>See man timescanner for full details of options to use.</p>
<p>
</p>
<hr />
<h1><a name="options">OPTIONS</a></h1>
<dl>
<dt><strong><a name="d_dir_directory" class="item"><strong>-d|-dir DIRECTORY</strong></a></strong></dt>

<dd>
<p>This option is mandatory for the tool to operate.  This option defines the starting directory which the tools recursively searches for supported artifacts.</p>
</dd>
<dt><strong><a name="s_skew_time" class="item"><strong>-s|-skew TIME</strong></a></strong></dt>

<dd>
<p>Time skew of original machine. The format of the variable TIME is: X | Xs | Xm | Xh, where X is a integer and s represents seconds, m minutes and h hours (default behaviour is sec
onds)</p>
</dd>
<dt><strong><a name="m_text" class="item"><strong>-m TEXT</strong></a></strong></dt>

<dd>
<p>Prepend the output line with TEXT, for instance by using -m HOSTNAME to include a hostname in the output</p>
</dd>
<dt><strong><a name="o_output_format" class="item"><strong>-o|-output FORMAT</strong></a></strong></dt>

<dd>
<p>Use the following output format.  By default <strong>log2timeline</strong> uses the csv output.  To see a list of all available output formats, use -o list</p>
</dd>
<dt><strong><a name="w_write_filename" class="item"><strong>-w|-write FILENAME</strong></a></strong></dt>

<dd>
<p>Specify a file to write output to (otherwise STDOUT will be chosen).</p>
</dd>
<dt><strong><a name="z_zone_timezone" class="item"><strong>-z|-zone TIMEZONE</strong></a></strong></dt>

<dd>
<p>This option defines the timezone that was used on the computer that the log files belonged to.  The default value for this variable is the local timezone of the computer timescanner is run on.</p>
</dd>
<dt><strong><a name="log_filename" class="item"><strong>-log FILENAME</strong></a></strong></dt>

<dd>
<p>Specify a file to write error and information messages from the <strong>log2timeline</strong> to a file, otherwise STDERR will be used.</p>
</dd>
<dt><strong><a name="name_host" class="item"><strong>-name HOST</strong></a></strong></dt>

<dd>
<p>Define the host name that the information is extracted from.</p>
</dd>
<dt><strong><a name="c_calculate" class="item"><strong>-c|-calculate</strong></a></strong></dt>

<dd>
<p>If this option is used then a MD5 sum for each file that passes verification is calculated and included in the timestamp object</p>
</dd>
<dt><strong><a name="x" class="item"><strong>-x</strong></a></strong></dt>

<dd>
<p>Make <strong>timescanner</strong> skip the default minimalist test to see if a file can be parsed by the supplied input module.</p>
</dd>
<dt><strong><a name="v_version" class="item"><strong>-V|-Version</strong></a></strong></dt>

<dd>
<p>Display the version number</p>
</dd>
<dt><strong><a name="v_verbose" class="item"><strong>-v|-verbose</strong></a></strong></dt>

<dd>
<p>Add the verbose level of output, or debug level.  This option can be provided twice to get an extra level of verbosity (two levels available)</p>
</dd>
<dt><strong><a name="h_help" class="item"><strong>-h|-help|-?</strong></a></strong></dt>

<dd>
<p>Display this help message</p>
</dd>
<dt><strong><a name="f_format_module" class="item"><strong>-f|--format</strong> MODULE</a></strong></dt>

<dd>
<p>The option of -f can be used to select which modules are used in timescanner when recursively searching through the directory supplied to the tool.  The option MODULE can be any of the four listed here:</p>
<dl>
<dt><strong><a name="f_list" class="item"><strong>-f list</strong></a></strong></dt>

<dd>
<p>Print a list of all available modules the tool supports, alongside a print-out of the available lists (preselected modules that can be chosen)</p>
</dd>
<dt><strong><a name="f_name_of_a_module" class="item"><strong>-f NAME OF A MODULE</strong></a></strong></dt>

<dd>
<p>If a list of available modules is presented, only those modules will be used by the tool.  One module can be supplied, or a list separated with a comma (,). An example</p>
<dl>
<dt><strong><a name="timescanner_z_local_f_evtx_oxml_pdf_d" class="item">timescanner -z local -f evtx,oxml,pdf -d .</a></strong></dt>

</dl>
<p>This will run timescanner on the current directory and only use the modules evtx, oxml and pdf in the process.</p>
</dd>
<dt><strong><a name="f_name_of_a_module2" class="item"><strong>-f=&quot;-NAME OF A MODULE&quot;</strong></a></strong></dt>

<dd>
<p>This option can be used to exclude a given module from being run (either a single one or a list, separated with a comma), an example:</p>
<dl>
<dt><strong><a name="timescanner_z_local_f_evtx_exif_d" class="item">timescanner -z local -f=&quot;-evtx,exif&quot; -d .</a></strong></dt>

</dl>
<p>This will run the tool against the current directory and use all of the modules available EXCEPT the evtx and exif ones.</p>
</dd>
<dt><strong><a name="f_name_of_a_list" class="item"><strong>-f NAME OF A LIST</strong></a></strong></dt>

<dd>
<p>There exist few available presets, or lists of available modules that can be used.  See the available lists by issuing <strong>timescanner -f list</strong>.  An example</p>
<dl>
<dt><strong><a name="timescanner_z_local_f_winxp_d_mnt_xpimage" class="item">timescanner -z local -f winxp -d /mnt/xpimage</a></strong></dt>

</dl>
<p>This will run the tool against the directory /mnt/xpimage, and only use the modules that are associated to a Windows XP system, according to the winxp list file.</p>
</dd>
</dl>
</dd>
<dt><strong><a name="e_exclude_string" class="item"><strong>-e|--exclude STRING</strong></a></strong></dt>

<dd>
<p>A comma separated list of files to exclude from the scan.  If a particular file has caused the tool to crash or not work, or you simply want to exclude some documents from the scan it is possible to exclude some</p>
<p>Example:</p>
<p><em>timescanner -f winvista -z local -d /mnt/windows -e 'Windows-Diagnosis,secret[0-3]'</em></p>
<p>This would scan all the directory /mnt/windows recursively, using only modules associated to a Windows Vista or later operating system, and excluding all filenames that have &quot;Windows-Diagnosis&quot; in them or contain the word secret0/secret1/secret2 or secret3 in it.</p>
</dd>
</dl>
<p>
</p>
<hr />
<h1><a name="author">AUTHOR</a></h1>
<p>Kristinn Gudjonsson &lt;kristinn (a t) log2timeline ( d o t ) net&gt; is the original author of the program.</p>
<p>
</p>
<hr />
<h1><a name="copyright">COPYRIGHT</a></h1>
<p>The tool is released under GPL so anyone can contribute to the tool.  Some parts of the code have been copied from other GPL'ed programs, such as RegRipper written by H. Carvey.</p>
<p>
</p>
<hr />
<h1><a name="see_also">SEE ALSO</a></h1>
<p><em>log2timeline</em></p>

</body>

</html>
